Backend readme #1470
Backend readme #1470
Conversation
|
Thanks for submitting this. Documentation looks really nice. Would you mind adding instructions to test locally as well? |
yeah will do that as well, where can I find a reference for that? |
|
|
I think just direct them to install yarn. This is also what @MahtabBukhari recommended in the hunters tribe: "Run the command 'yarn install'. After that, execute 'yarn jest test-file-name'. As you run the command, an error will occur in the node module file. There are three files you have to open from the link shown with the error in the terminal. After opening each file, comment out the entire content. Once you have commented out these three files, on the fourth attempt, you should be able to run the test locally." |
Sure, Adding these instructions right away, Thanks |
|
@ecurrencyhodler quick question, as far as what I have learned we use jest for frontend testing and mockery for backend testing, so I think the instructions for setting up jest locally should be added to the frontend readme and not on this, let me know If I got that wrong. |
|
OOo good point. You're right. Let's get a review on your instructions from raph/kev and then merge. |
| ``` | ||
| MEME_URL= | ||
| ``` | ||
| Configure Redis by adding the `REDIS_URL` or other relevant variables to your `.env` file. |
There was a problem hiding this comment.
Can you specify the other relevant variables?
REDIS_HOST=
REDIS_USER=
REDIS_PASS=
REDIS_DB=
To make it easier for developers.
|
@elraphty yeah , will update this |
|
@elraphty updated the readme |
| @@ -78,6 +77,14 @@ go build . | |||
|
|
|||
| Configure Redis by adding the `REDIS_URL` or other relevant variables to your `.env` file. | |||
|
|
|||
| ```sh | |||
|
@elraphty it will format the text in a code block |
|
good work. paid! |
This PR is focused on the updating the Readme to be backend focused only, issue #1463